.TH FL_join 3 "Dec 2000" "Flush Spread" "User Manuals"
.SH NAME
FL_join \- join a connection to a Flush Spread group
.SH SYNOPSIS
.B #include <fl.h>

.BI "int FL_join(mailbox " mbox ", const char *" group_name ");"
.SH DESCRIPTION
.B FL_join
joins the connection represented by 
.I mbox
to a group with the name
.IR group_name .
If the group does not exist among the Spread daemons it is created,
otherwise the connection is joined to the existing group.  A
connection may not join a group it is already a member of, which it
has already joined, or from which it is currently leaving.
.SH "RETURN VALUES"
Returns 0 on success or one of the following errors ( < 0 ):
.TP
.B ILLEGAL_GROUP
The 
.I group_name
given to join was illegal for some reason, usually because it was of
length 0 or length > MAX_GROUP_NAME.  This error is also returned if a
group with which this connection is already involved (i.e. - already
joining, already joined, currently leaving) is joined again.
.TP
.B ILLEGAL_SESSION
The connection represented by
.I mbox
is illegal. Usually because it is not active.
.TP
.B CONNECTION_CLOSED
Errors occurred during communication and the join could not be
initiated.
.SH AUTHOR
John Schultz <jschultz@cnds.jhu.edu>
